digipot10.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef DIGIPOT10_H
#define DIGIPOT10_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define DIGIPOT10_REG_VOLATILE_WIPER_0          0x01
#define DIGIPOT10_REG_VOLATILE_WIPER_1          0x02
#define DIGIPOT10_REG_NV_WIPER_0                0x03
#define DIGIPOT10_REG_NV_WIPER_1                0x04
#define DIGIPOT10_REG_GP_DATA_0                 0x05
#define DIGIPOT10_REG_GP_DATA_1                 0x06
#define DIGIPOT10_REG_GP_DATA_2                 0x07
#define DIGIPOT10_REG_STATUS                    0x08
#define DIGIPOT10_REG_LOCK                      0x09
#define DIGIPOT10_REG_TERMINAL_CONTROL          0x0A
#define DIGIPOT10_REG_SYNC                      0x0B
#define DIGIPOT10_REG_CRC                       0x0C
#define DIGIPOT10_REG_RESET                     0x0D
#define DIGIPOT10_REG_NV_W_0_COUNT              0x15
#define DIGIPOT10_REG_NV_W_1_COUNT              0x17
#define DIGIPOT10_REG_DATA_0_COUNT              0x19
#define DIGIPOT10_REG_DATA_1_COUNT              0x1B
#define DIGIPOT10_REG_DATA_2_COUNT              0x1D

#define DIGIPOT10_CMD_REG_MASK                  0xF8
#define DIGIPOT10_CMD_OP_WRITE_DATA             0x00
#define DIGIPOT10_CMD_OP_READ_DATA              0x07
#define DIGIPOT10_CMD_OP_INCREMENT_WIPER        0x02
#define DIGIPOT10_CMD_OP_DECREMENT_WIPER        0x04
#define DIGIPOT10_CMD_OP_MASK                   0x07
#define DIGIPOT10_DATA_MASK                     0x03FF
 // digipot10_reg



#define DIGIPOT10_STATUS_ECED                   0x0040
#define DIGIPOT10_STATUS_SPIWDT                 0x0020
#define DIGIPOT10_STATUS_CMDERR                 0x0010
#define DIGIPOT10_STATUS_CRCERR                 0x0008
#define DIGIPOT10_STATUS_SRST                   0x0004
#define DIGIPOT10_STATUS_POR                    0x0002
#define DIGIPOT10_STATUS_MTPMA                  0x0001

#define DIGIPOT10_LOCK_LOCKNV                   0x0002
#define DIGIPOT10_LOCK_LOCKV                    0x0001

#define DIGIPOT10_TCON0_R1A                     0x0020
#define DIGIPOT10_TCON0_R1W                     0x0010
#define DIGIPOT10_TCON0_R1B                     0x0008
#define DIGIPOT10_TCON0_R0A                     0x0004
#define DIGIPOT10_TCON0_R0W                     0x0002
#define DIGIPOT10_TCON0_R0B                     0x0001

#define DIGIPOT10_SYNC_WLAT                     0x0004
#define DIGIPOT10_SYNC_WRSYNC                   0x0002
#define DIGIPOT10_SYNC_IDSYNC                   0x0001

#define DIGIPOT10_CRC_CRCEN                     0x0001

#define DIGIPOT10_RESET_SWRSTVAL                0x00A5

#define DIGIPOT10_WIPER_FULL_SCALE              0x03FF
#define DIGIPOT10_WIPER_MID_SCALE               0x0200
#define DIGIPOT10_WIPER_ZERO_SCALE              0x0000

#define DIGIPOT10_DEVICE_ADDRESS_A1A0_00        0x2C
#define DIGIPOT10_DEVICE_ADDRESS_A1A0_01        0x2D
#define DIGIPOT10_DEVICE_ADDRESS_A1A0_10        0x2E
#define DIGIPOT10_DEVICE_ADDRESS_A1A0_11        0x2F

#define DIGIPOT10_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define DIGIPOT10_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 // digipot10_set



#define DIGIPOT10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );
 // digipot10_map // digipot10

typedef enum
{
    DIGIPOT10_DRV_SEL_SPI,          
    DIGIPOT10_DRV_SEL_I2C           
 
} digipot10_drv_t;

struct digipot10_s;
typedef err_t ( *digipot10_master_io_t )( struct digipot10_s*, uint8_t, uint8_t*, uint8_t ); 

typedef struct digipot10_s
{
    i2c_master_t i2c;               
    spi_master_t spi;               
 
    uint8_t      slave_address;     
    pin_name_t   chip_select;       
    digipot10_drv_t drv_sel;        
 
    digipot10_master_io_t write_f;  
    digipot10_master_io_t read_f;   
 
} digipot10_t;

typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
 
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
    digipot10_drv_t drv_sel;        
 
} digipot10_cfg_t;

typedef enum
{
    DIGIPOT10_OK = 0,
    DIGIPOT10_ERROR = -1
 
} digipot10_return_value_t;


void digipot10_cfg_setup ( digipot10_cfg_t *cfg );

void digipot10_drv_interface_sel ( digipot10_cfg_t *cfg, digipot10_drv_t drv_sel );

err_t digipot10_init ( digipot10_t *ctx, digipot10_cfg_t *cfg );

err_t digipot10_default_cfg ( digipot10_t *ctx );

err_t digipot10_write_reg ( digipot10_t *ctx, uint8_t reg, uint16_t data_in );

err_t digipot10_read_reg ( digipot10_t *ctx, uint8_t reg, uint16_t *data_out );

err_t digipot10_increment_wiper ( digipot10_t *ctx, uint8_t reg );

err_t digipot10_decrement_wiper ( digipot10_t *ctx, uint8_t reg );

err_t digipot10_soft_reset ( digipot10_t *ctx );

err_t digipot10_set_wiper_0 ( digipot10_t *ctx, uint16_t wiper );

err_t digipot10_set_wiper_1 ( digipot10_t *ctx, uint16_t wiper );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT10_H
 // digipot10
 
// ------------------------------------------------------------------------ END